home *** CD-ROM | disk | FTP | other *** search
/ Shareware Grab Bag / Shareware Grab Bag.iso / 011 / gumup1.arc / FK.DOC < prev    next >
Text File  |  1985-06-26  |  9KB  |  193 lines
  1. ************************************************************************
  2.   DOCUMENTATION FOR FK: A FUNCTION KEY HANDLER FOR PC-DOS 1.0 and 1.1
  3. **********************************************************************
  4.  
  5. I.  Introduction
  6.  
  7.         This document describes the program FK, a function key handler for
  8. use under IBM PC-DOS versions 1.0 and 1.1.  The program may not work
  9. under other versions of DOS.
  10.  
  11.         The program was developed under a grant from Userview Corporation.
  12.  
  13.  
  14. II.  Rationale
  15.  
  16.         Under standard PC-DOS, the ten function keys are not used to their
  17. full potential.  The keys are used for simple command line editing, and
  18. several of the functions are duplicated by other keys on the keyboard.
  19. FK allows you to assign strings up to 24 characters in length to each
  20. of the function keys, so you can give an entire command or file name
  21. with a single keypress.
  22.  
  23.         For those who use the normal PC-DOS command line editing facilities,
  24. FK moves functions not already duplicated to keys on the cursor moving pad.
  25.  
  26.  
  27. III.  Using the program
  28.  
  29.         There are five different actions available with FK.  They all
  30. begin with the command name 'FK'; of course, the FK program (FK.COM) must be
  31. available on the selected disk drive when the command is issued.
  32.  
  33.         The actions are as follows:
  34.  
  35.         SHOWING THE DEFINITIONS:  You may display the current definitions
  36. of the ten function keys by giving the command "FK". Control characters
  37. imbedded in the strings are displayed as ^x (just as they are echoed
  38. during command line input) except for carriage return (ENTER), which is
  39. displayed as a leftward-pointing arrow.  Users with a printer may get
  40. a hardcopy of their definitions by pressing CTRL-PRTSC before giving the
  41. FK command.
  42.  
  43.         REDEFINING A KEY:  You may assign a string to one of the function
  44. keys by giving the command "FK Fn <string>" where n is the number of the
  45. key to assign (1 thru 10), and <string> is the string of characters you
  46. wish to get when you press that key.  For example, "FK F1 DIR" would
  47. assign the directory command "DIR" to function key F1.  You may include
  48. a carriage return in the string by using the vertical line character (|)
  49. wherever you want the CR; for example, "FK F1 DIR|" would do the directory
  50. command immediately upon your pressing F1 (in the previous case, you would
  51. have to press ENTER yourself after pressing F1).  Keys may only be assigned
  52. strings of up to 24 characters in length; strings which are too long will
  53. be truncated without warning.
  54.  
  55.         SAVING THE DEFINITIONS:  You may save the current definitions of
  56. the function keys to a disk file for later use (see LOADING below).  To
  57. do so, give the command "FK SAVE <fname>" where <fname> is the name of
  58. the file in which to save the definitions.  For example, "FK SAVE MY.KEY"
  59. would save all current key assignments in the file "MY.KEY".  Any valid
  60. filename may be used, but the use of the ".KEY" extension is recommended
  61. for clarity.
  62.  
  63.         LOADING KEY DEFINITIONS:  You may recover key definitions previously
  64. saved with "FK SAVE" by typing "FK LOAD <fname>", where <fname> is the
  65. name of the file containing the key definitions.  You should *only* use
  66. this command on files which have been created by "FK SAVE"; if you don't,
  67. FK will probably not accept the file.  The key definitions which are
  68. automatically loaded with FK when it is first called should be available
  69. in the file "STD.KEY" on the disk with this document.
  70.  
  71.         GETTING HELP: You can get a rundown of these command formats by
  72. typing "FK HELP".
  73.  
  74.  
  75. IV.  Notes
  76.  
  77.         Abbreviations: You can use S, L, and H as abbreviations for
  78. "SAVE", "LOAD", and "HELP", respectively.  For example, you might type
  79. "FK L STD.KEY" to recover those definitions.
  80.  
  81.         Warning concerning key files:  Attempting to load key files
  82. which were not created with "FK SAVE" or which were altered with DEBUG
  83. or some editor may result in system crashes.
  84.  
  85.         Command line editing facilities:  As mentioned, the old actions
  86. assigned to the function keys have been moved to the cursor keypad.
  87. F1 (copy one char from template) has always been duplicated by the cursor-
  88. right key.  With FK active, the skip/copy function of F2 is moved to
  89. the cursor-up key.  Copy-remaining (F3) is moved to the END key.
  90. Skip/delete (F4) is now assigned to the down-arrow key. Move-displayed (F5)
  91. has been reassigned to the HOME key.
  92.  
  93.         F6 was used by DOS to issue the end-of-file mark, ^Z.  The
  94. standard key definitions leave ^Z assigned to F6, but if you need to
  95. change this, you can always signal end-of-file by typing CTRL-Z.
  96.  
  97.  
  98. V. Additions to revision 2 (28 July 1982)
  99.  
  100.         The following enhancements have been added to FK as of 28 July 1982.
  101. Thanks to Webb Blackman, Jr. , and Michael Sullivan for suggestions and
  102. comments.
  103.  
  104.         * QUIET MODE: To prevent extraneous output during FK processing
  105.           (for example, the possibly unwanted listing of key definitions
  106.           during a "load" in an autoexec file), the 'quiet mode' option
  107.           has been added.  Preceeding any command letter with 'Q' causes
  108.           most output to be suppressed.  Copyright notices and error
  109.           messages will be displayed even if quiet mode is requested.
  110.           Example: "FK QL DEV.KEY" to 'quietly' load the definition file
  111.           "DEV.KEY".
  112.  
  113. CHANGES AND REVISIONS:
  114.  
  115. 1) Carriage returns are now displayed as a vertical bar instead of
  116.    a left arrow. This change was made since the left arrow is a character
  117.    27 (escape), which many printers use as a "here comes a command"
  118.    signal.
  119.  
  120. 2) The file name you're using to SAVE your definitions is displayed
  121.    at the conclusion of a successful SAVE.  No drive or extension
  122.    spec is displayed, however.
  123.  
  124. 3) The much-demanded FK RESET option is now available.  Typing FK R
  125.    puts FK asleep until another FK command is issued, at which point
  126.    it reawakens (unless that is another FK R, in which case FK
  127.    is awake only a millisecond or so).  Please experiment with this
  128.    option under several systems (EDIX and VOLKSWRITER come to mind)
  129.    to make sure it behaves like you want it to.
  130.  
  131.  
  132.             PATCHING FK FOR NONSTANDARD OPERATING SYSTEMS
  133.  
  134.      FK  is  designed to lodge itself properly in one of two different
  135. operating systems. Standard FK can handle DOS 1.00 and DOS  1.10.  For
  136. any given unusual system (i.e. hard disk, RAM-resident disk, etc.) the
  137. program  may  not  operate properly and may have to be modified as per
  138. the following instructions:
  139.  
  140.      1.  Boot the oddball operating system.
  141.  
  142.      2.  Using DEBUG, search segment 60 for the following string:
  143.  
  144.             3C 3E 3D 3D 3F
  145.  
  146.          The resulting address is the TABLE address.
  147.  
  148.      3.  Search segment 60 for the following string:
  149.  
  150.             92 B4 00 CD 16
  151.  
  152.         The resulting address is the VECTOR address.
  153.  
  154.      4.  Note that both the TABLE and VECTOR addresses are offsets in
  155.          segment 60H.  If either of them cannot be found, FK probably
  156.          cannot be patched to run in this environment.
  157.  
  158.      5.  DEBUG FK.COM
  159.  
  160.      6.  In the code segment at location 210 are six bytes which must be
  161.          patched to allow for the new operating system.  At 210 and 211 are
  162.          the two "identifier bytes" printed by FK when it signs on
  163.          (i.e. DOS 1.xx-- xx are the ID bytes).  For example, the RAMDrive
  164.          version of FK under DOS 1.1 has "1r" as ID bytes.
  165.  
  166.      7.  The next two bytes (locations 212-213) must contain the TABLE
  167.          address in normal low - high order.  For example, if the search
  168.          returned address 0B88 for the TABLE address, one might do an
  169.          ECS:212 88 0B
  170.  
  171.      8.  The next two bytes (locations 214-215) must contain the VECTOR
  172.          address in low - high order, much as in the previous example.
  173.  
  174.      9.  When the patches have been made, use W to save the new version
  175.          of FK.COM.  One should, of course, back up the program first
  176.          in case something went wrong.
  177.  
  178.      When following this patching procedure, FK will  work  under  the
  179. desired  operating  system as well as under vanilla DOS 1.10. If it is
  180. necessary to use something else  besides  1.10,  the  patches  may  be
  181. performed  at  location  216  as  well, allowing two oddball operating
  182. systems.
  183.  
  184.      The author assumes absolutely no responsibility  for  anguish  or
  185. lost data caused by attempting to patch FK.
  186.  
  187. KNOWN PATCHES:
  188.  
  189. for DOS 1.00:                  ecs:210 30 30 18 05 C7 00
  190. for JEL/JFORMAT:               ecs:210 31 6A 88 0B 95 00
  191. for JEL/JFORMAT v1.62:         ecs:210 31 6A 88 0D 95 00
  192. for Microsoft RAMDrive:        ecs:210 31 72 48 06 95 00
  193.